/*
 * Copyright (C) 2023 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.android.tools.idea.flags

import com.intellij.openapi.options.UnnamedConfigurable

interface ExperimentalConfigurable : UnnamedConfigurable {
  /**
   * return [ApplyState.BLOCK] if the state to be applied is invalid in any way.  If it is, display
   * UI indications to the user to highlight the problem(s).  Return [ApplyState.RESTART] if the state
   * is ready to be applied but requires the IDE to restart to take effect, or [ApplyState.OK] otherwise.
   */
  fun preApplyCallback(): ApplyState = ApplyState.OK

  /**
   * perform any necessary actions to clean up after applying new settings, not including restarting
   * the IDE.
   */
  fun postApplyCallback() = Unit

  enum class ApplyState {
    OK,
    BLOCK,
    RESTART
  }
}